Developer Documentation

QuickTime 4 API Documentation

Wired Movies and Sprites

| Previous | Chapter Contents | Chapter Top | Next |

Movie Action Constants

The following movie action constants enable you to set the properties of a movie. For example, you can use these constants to create play and pause buttons which control the movie's rate.

Constant descriptions

kActionMovieSetVolume
IsDelta , WrapsAround Param1: [short volume] Default Min: 0, Default Max: 255

This sets the movie's volume level.

kActionMovieSetRate
Supported Flags: IsDelta , WrapsAround Param1: [Fixed rate] Default Min: minFixed , Default Max: maxFixed

This sets the movie's playback rate. A rate of 1 means play back at normal speed. A rate of two means play back at double speed. A rate of 0 means stop. Negative rates make the movie play backwards. Rates may be fractional.

kActionMovieSetLoopingFlags
Supported Flags: none Param1: [long loopingFlags]

This sets the looping mode of movie playback. Zero means no looping. Setting the loopTimeBase flag means that the movie will loop; additionally setting the palindromeLoopTimeBase flag causes the movie to loop in palindrome fashion, meaning that once it reaches the end, it goes backwards until reaching the beginning, at which point it will go forward again. Note that the flags loopTimeBase and palindromeLoopTimeBase are OR-combined together.

kActionMovieGoToTime
none Param1: [TimeValue time]

This sets the movie's current time. This value is expressed in the movie's timescale.

kActionMovieGoToTimeByName
none Param1: [Str255 timeName]

Sets the movie's current time to the one in the movie corresponding to the chapter named timeName .

kActionMovieGoToBeginning
none No Params

Sets the time to the beginning of the movie.

kActionMovieGoToEnd
Supported Flags: none No Params

Sets the time to the end of the movie.

kActionMovieStepForward
Supported Flags: none No Params

This causes the movie to step forward in the same fashion as pressing the step forward button in the movie controller.

kActionMovieStepBackward
Supported Flags: none No Params

This causes the Movie to step backward in the same fashion as pressing the step backward button in the movie controller.

kActionMovieSetSelection
none Param1: [TimeValue startTime] Param2: [TimeValue endTime]

Sets the movie's selection to be the time range specified by the startTime and endTime time values.

kActionMovieSetSelectionByName
Supported Flags: none Param1: [Str255 startTimeName] Param2: [Str255 endTimeName]

Sets the movie's selection to be the time range specified by the startTimeName and endTimeName chapter names.

kActionMoviePlaySelection
Supported Flags: IsToggle Param1 : [ Boolean selectionOnly ]

When set to true , the movie plays only the current movie selection. The movie selection may be set using kActionMovieSetSelection or kActionMovieSetSelectionByName .

kActionMovieSetLanguage
Supported Flags: none Param1: [long language ]

Sets the movie's current language. This causes the tracks associated with that language to be enabled and track's associated with other languages to be disabled.


© 1999 Apple Computer, Inc.

| Previous | Chapter Contents | Chapter Top | Next |